All About Connecting EPM Cloud Environments & Managing it via REST API!

Connections

Service Administrators can connect multiple EPM Cloud environments of the following types:

• Planning
• FreeForm
• Financial Consolidation and Close
• Tax Reporting
• Profitability and Cost Management
• Enterprise Profitability and Cost Management
• Account Reconciliation
• Narrative Reporting
• Oracle Strategic Workforce Planning Cloud

Once Service Administrators set up the connections, users who have access across EPM Cloud environments can navigate across them from a single access point with one login. 

Also, artifacts such as forms and dashboards, from across environments can be co-mingled within a cluster or within tabs on a card in navigation flows. Artifacts in the target environment are accessible based on the user's role.

EPM Cloud environments can I connect?

The source environment is the environment from which you're creating the connection. The target environment is the environment you're connecting to from the source environment.

You can connect these source environments (these environments can also be target environments):

• Planning
• FreeForm
• Financial Consolidation and Close
• Tax Reporting

Source environments can also connect to these target environments (these environments can't be source environments):

• Account Reconciliation
• Profitability and Cost Management
• Enterprise Profitability and Cost Management
• Narrative Reporting
• Strategic Workforce Planning

Let's explore how to manage the Connections using the REST API

Use these REST APIs to work with connections.

With multiple environments, using REST APIs saves you time and effort by automating the process of logging in and configuring connections.

View a Connection

Use this REST API to view details for a connection that is saved in an application.

Required Roles

Service Administrator

GET 

/HyperionPlanning/rest/epm/{api_version}/applications/{application}/connections/{connectionRef}

Request

Supported Media Types: application/json

View All Connections

Use this REST API to view details for all of the connections saved in an application.

Required Roles

This API supports paging, so you can filter the number of connections you see in the output using the offset and limit parameters shown in the table.

Service Administrator

REST Resource

GET /HyperionPlanning/rest/epm/{api_version}/applications/{application}/connections

Request

Supported Media Types: application/json

Update a Connection

Use this REST API to update a specific connection that is saved in an application.

Required Roles

You can update the values using either a plain text password or encrypted password. The response returns the updated connection details.

Service Administrator

REST Resource

GET /HyperionPlanning/rest/epm/{api_version}/applications/{application}/connections/{connectionRef}

Request

Supported Media Types: application/json

The same can be validated in the Web Interface too,

Hope this was useful, cheers!!